Help system

Help system

The help system in ClassiX® is called up from an active application window by pressing the F1 key. The help texts are organised in such a way that they are linked to the entire ClassiX® documentation and can easily be adapted to customer-specific information. The organisation of the ClassiX® help system is geared towards multilingualism.

In the module itself the name of the help file is defined: Module(delinedt, HELP("delinote")): delinote
The windows then refer to the respective anchor: Window(EditWin, HELP("#EditWin"),...

Installation of the help system

The current ClassiX® documentation is made available online via Tiki Wiki. The customer-specific documentation is stored via a locally set up Tiki Wiki. Accordingly, CX_HELPROOT_APPSWH must refer to the local web address.

We distinguish between the user documentation (appswarehouse.de) and the developer documentation (instantview.org).

In the batch file at the start of the ClassiX® system, besides the general path specification CX_ROOTDIR, the path specifications for the documentation directories must be set as environment variables: CX_HELPROOT, CX_HELPROOT_APPSWH, CX_HELPROOT_INSTANTVIEW. and CX_WIKI_HELP.

Example: